Skip to content

Commands

Headers

  • # = Section title (h1)
  • ## = Paragraph title (h2)
  • ### = Sub-paragraph title (h2)

Lists

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs help - Print this help message.

Note

When a text that introduce a list leave an empty row from the text and the list

Tables

First Header Second Header Third Header
Content Cell Content Cell Content Cell
Content Cell Content Cell Content Cell
First Header | Second Header | Third Header
------------ | ------------- | ------------
Content Cell | Content Cell  | Content Cell
Content Cell | Content Cell  | Content Cell

Note

In order to past multiline into mkdocs source code pages is necessary use fences. More information at http://mkdocs.readthedocs.io/en/0.10/user-guide/writing-your-docs/